﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>getScheduledtasks </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="getScheduledtasks ">
    <meta name="generator" content="docfx 2.59.2.0">
    
    <link rel="shortcut icon" href="../../../favicon.ico">
    <link rel="stylesheet" href="../../../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../../../styles/docfx.css">
    <link rel="stylesheet" href="../../../styles/main.css">
    <link rel="stylesheet" href="../../../styles/socialbar.css">
    <link rel="stylesheet" href="../../../styles/header.css">
    <link rel="stylesheet" href="../../../styles/version.css">
    <link href="https://fonts.googleapis.com/css?family=Roboto:400,100,300,500,700,100italic,300italic,400italic" rel="stylesheet" type="text/css">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
    <meta property="docfx:navrel" content="../../../toc.html">
    <meta property="docfx:tocrel" content="../../toc.html">
    <meta property="docfx:uid" content="emby.restapi/getScheduledtasks">
    
    <meta property="docfx:rel" content="../../../">
    
    <script type="text/javascript" src="../../../nav.js"></script>
    <script type="text/javascript" src="../../toc.js"></script>
  
  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <div class="mb-socials-heading" style="height: 40px;">
        	<div class="mb-socials-heading-inner container">
        		<div class="mb-socials-heading-right">
        			<div class="mb-socials-list">
                          
        				<div class="mb-socials-item facebook">
        					<a class="mb-socials-item-link" target="_blank" href="https://facebook.com/embyapp"></a>
        					<div class="mb-socials-item-popup">
        						<span>Facebook</span>
        					</div>
        				</div><div class="mb-socials-item twitter">
        					<a class="mb-socials-item-link" target="_blank" href="https://twitter.com/embyapp"></a>
        					<div class="mb-socials-item-popup">
        						<span>Twitter</span>
        					</div>
        				</div>
        				<div class="mb-socials-item pinterest">
        					<a class="mb-socials-item-link" target="_blank" href="https://www.pinterest.com/emby0240/emby-news/"></a>
        					<div class="mb-socials-item-popup">
        						<span>Pinterest</span>
        					</div>
        				</div>
        				<div class="mb-socials-item tumblr">
        					<a class="mb-socials-item-link" target="_blank" href="https://embyapp.tumblr.com/"></a>
        					<div class="mb-socials-item-popup">
        						<span>Tumblr</span>
        					</div>
        				</div>
        				<div class="mb-socials-item github">
        					<a class="mb-socials-item-link" target="_blank" href="https://github.com/MediaBrowser"></a>
        					<div class="mb-socials-item-popup">
        						<span>GitHub</span>
        					</div>
        				</div><div class="mb-socials-item rss">
        					<a class="mb-socials-item-link" target="_blank" href="https://emby.media/blog.xml"></a>
        					<div class="mb-socials-item-popup">
        						<span>RSS</span>
        					</div>
        				</div>
                          
        			</div>
        		</div>
        	</div>
        </div>
        <div class="container">
        	<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
        		  
        		  <a class="navbar-brand" href="../../../index.html">
        		    <img id="logo" class="svg" src="../../../images/emby_dev_logo.png" alt="">
        		  </a>
        		  <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
        			<span class="sr-only">Toggle navigation</span>
        			<span class="icon-bar"></span>
        			<span class="icon-bar"></span>
        			<span class="icon-bar"></span>
        		  </button>
        		<div class="collapse navbar-collapse" id="navbar">
        			
        			<ul class="nav level1 navbar-nav">
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../../index.html" title="DEV Home">DEV Home</a>
        			      </li>
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../../doc/index.html" title="Documentation">Documentation</a>
        			      </li>
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../../reference/index.html" title="Reference">Reference</a>
        			      </li>
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../../download/index.html" title="Download">Download</a>
        			      </li>
        			</ul>		</div>
        	</nav>
        </div>
        <div class="nav-overlay d-none"></div>        
        <div class="subnav navbar navbar-default">
          <div class="container">
            <div class="hide-when-search" id="breadcrumb">
        	  <ul class="breadcrumb">
        		<li></li>
        	  </ul>
        	</div>
        
        	<div class="breadcrumpsearch">
        	  <form class="navbar-form navbar-right" role="search" id="search">
        		<div class="form-group">
        		  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
        		</div>
        	  </form>
        	</div>
          </div>
        </div>
      </header>
      <div class="container body-content">
        
        <div id="search-results">
          <div class="search-list">Search Results for <span></span></div>
          <div class="sr-items">
            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
          </div>
          <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
        </div>
      </div>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="emby.restapi/getScheduledtasks">
<div class="refdoc">

<h1 id="emby_restapi_getScheduledtasks" data-uid="emby.restapi/getScheduledtasks" class="text-capitalize text-break">getScheduledtasks</h1>
<div class="markdown level0 summary"><p>Gets scheduled tasks</p>
</div>
<div class="markdown level0 description"><p>Requires authentication as administrator</p>
</div>




  
  
  
   <h3 id="emby_restapi_getScheduledtasks_operation" data-uid="emby.restapi/getScheduledtasks/operation" style="display:none;" class="text-capitalize">getScheduledtasks</h3>
  <h5>Request</h5>
  <div class="codewrapper">
    <pre><code class="lang-restApi hljs"><span class="opspan opspan-get">get</span> /ScheduledTasks</code></pre>
  </div>
  <h5>Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>In</th>
        <th>Type</th>
        <th>Default</th>
        <th>Notes</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="parametername">IsHidden</span></td>
        <td>query</td>
        <td>
              
  
        </td>
        <td></td>
        <td><p>Optional filter tasks that are hidden, or not.</p>
</td>
      </tr>
      <tr>
        <td><span class="parametername">IsEnabled</span></td>
        <td>query</td>
        <td>
              
  
        </td>
        <td></td>
        <td><p>Optional filter tasks that are enabled, or not.</p>
</td>
      </tr>
    </tbody>
  </table>
  <div class="responses">
    <h5>Responses</h5>
    <table class="table table-bordered table-striped table-condensed">
      <thead>
        <tr>
          <th>Status Code</th>
          <th>Type</th>
          <th>Description</th>
          <th>Samples</th>
        </tr>
      </thead>
      <tbody>
      <tr>
        <td><span class="status">200</span></td>
        <td>
  
              <a href="#MediaBrowser_Model_Tasks_TaskInfo" class="typelink">TaskInfo</a>
              []
        </td>
        <td><p>Operation successful. Returning a TaskInfo[] object.</p>
</td>
        <td class="sample-response">
        </td>
      </tr>
      <tr>
        <td><span class="status">400</span></td>
        <td>
              
  
        </td>
        <td><p>Bad Request. Server cannot process request.</p>
</td>
        <td class="sample-response">
        </td>
      </tr>
      <tr>
        <td><span class="status">401</span></td>
        <td>
              
  
        </td>
        <td><p>Unauthorized. Client needs to authenticate.</p>
</td>
        <td class="sample-response">
        </td>
      </tr>
      <tr>
        <td><span class="status">403</span></td>
        <td>
              
  
        </td>
        <td><p>Forbidden. No permission for the reqested operation.</p>
</td>
        <td class="sample-response">
        </td>
      </tr>
      <tr>
        <td><span class="status">404</span></td>
        <td>
              
  
        </td>
        <td><p>Resource not found or unavailable.</p>
</td>
        <td class="sample-response">
        </td>
      </tr>
      <tr>
        <td><span class="status">500</span></td>
        <td>
              
  
        </td>
        <td><p>Server error.</p>
</td>
        <td class="sample-response">
        </td>
      </tr>
      </tbody>
    </table>
  </div>
<h2 id="definitions">Definitions</h2>
  
  <h3 id="MediaBrowser_Model_Tasks_TaskInfo" class="text-capitalize">TaskInfo</h3>
  <div>
      <p>see also <a href="../../pluginapi/MediaBrowser.Model.Tasks.TaskInfo.html">MediaBrowser.Model.Tasks.TaskInfo</a></p>

  </div>
  <table class="table table-bordered table-striped table-condensed">
      <thead>
          <tr>
              <th>Name</th>
              <th>Type</th>
              <th>Notes</th>
          </tr>
      </thead>
      <tbody>
          <tr>
              <td><span class="parametername">Name</span></td>
              <td>
                    string
  
                  
              </td>
              <td><p>The name.</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">State</span></td>
              <td>
  
                      <a href="#MediaBrowser_Model_Tasks_TaskState" class="typelink">TaskState</a>
                  
              </td>
              <td><p>Enum TaskState</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">CurrentProgressPercentage</span></td>
              <td>
                    number
                      (double)
  
                  
              </td>
              <td><p>The progress.</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">Id</span></td>
              <td>
                    string
  
                  
              </td>
              <td><p>The id.</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">LastExecutionResult</span></td>
              <td>
  
                      <a href="#MediaBrowser_Model_Tasks_TaskResult" class="typelink">TaskResult</a>
                  
              </td>
              <td><p>Class TaskExecutionInfo</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">Triggers</span></td>
              <td>
  
                      <a href="#MediaBrowser_Model_Tasks_TaskTriggerInfo" class="typelink">TaskTriggerInfo[]</a>
                  
              </td>
              <td><p>The triggers.</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">Description</span></td>
              <td>
                    string
  
                  
              </td>
              <td><p>The description.</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">Category</span></td>
              <td>
                    string
  
                  
              </td>
              <td><p>The category.</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">IsHidden</span></td>
              <td>
                    boolean
  
                  
              </td>
              <td><p>A value indicating whether this instance is hidden.</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">Key</span></td>
              <td>
                    string
  
                  
              </td>
              <td><p>The key.</p>
</td>
          </tr>
      </tbody>
  </table>
  
  <h3 id="MediaBrowser_Model_Tasks_TaskState" class="text-capitalize">TaskState</h3>
  <div>
      <p>see also <a href="../../pluginapi/MediaBrowser.Model.Tasks.TaskState.html">MediaBrowser.Model.Tasks.TaskState</a></p>

  </div>
  <h5>Enum Values</h5>
  <ul>
  <li>Idle</li>
  <li>Cancelling</li>
  <li>Running</li>
  </ul>
  
  <h3 id="MediaBrowser_Model_Tasks_TaskResult" class="text-capitalize">TaskResult</h3>
  <div>
      <p>see also <a href="../../pluginapi/MediaBrowser.Model.Tasks.TaskResult.html">MediaBrowser.Model.Tasks.TaskResult</a></p>

  </div>
  <table class="table table-bordered table-striped table-condensed">
      <thead>
          <tr>
              <th>Name</th>
              <th>Type</th>
              <th>Notes</th>
          </tr>
      </thead>
      <tbody>
          <tr>
              <td><span class="parametername">StartTimeUtc</span></td>
              <td>
                    string
                      (date-time)
  
                  
              </td>
              <td><p>The start time UTC.</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">EndTimeUtc</span></td>
              <td>
                    string
                      (date-time)
  
                  
              </td>
              <td><p>The end time UTC.</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">Status</span></td>
              <td>
  
                      <a href="#MediaBrowser_Model_Tasks_TaskCompletionStatus" class="typelink">TaskCompletionStatus</a>
                  
              </td>
              <td><p>Enum TaskCompletionStatus</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">Name</span></td>
              <td>
                    string
  
                  
              </td>
              <td><p>The name.</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">Key</span></td>
              <td>
                    string
  
                  
              </td>
              <td><p>The key.</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">Id</span></td>
              <td>
                    string
  
                  
              </td>
              <td><p>The id.</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">ErrorMessage</span></td>
              <td>
                    string
  
                  
              </td>
              <td><p>The error message.</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">LongErrorMessage</span></td>
              <td>
                    string
  
                  
              </td>
              <td><p>The long error message.</p>
</td>
          </tr>
      </tbody>
  </table>
  
  <h3 id="MediaBrowser_Model_Tasks_TaskCompletionStatus" class="text-capitalize">TaskCompletionStatus</h3>
  <div>
      <p>see also <a href="../../pluginapi/MediaBrowser.Model.Tasks.TaskCompletionStatus.html">MediaBrowser.Model.Tasks.TaskCompletionStatus</a></p>

  </div>
  <h5>Enum Values</h5>
  <ul>
  <li>Completed</li>
  <li>Failed</li>
  <li>Cancelled</li>
  <li>Aborted</li>
  </ul>
  
  <h3 id="MediaBrowser_Model_Tasks_TaskTriggerInfo" class="text-capitalize">TaskTriggerInfo</h3>
  <div>
      <p>see also <a href="../../pluginapi/MediaBrowser.Model.Tasks.TaskTriggerInfo.html">MediaBrowser.Model.Tasks.TaskTriggerInfo</a></p>

  </div>
  <table class="table table-bordered table-striped table-condensed">
      <thead>
          <tr>
              <th>Name</th>
              <th>Type</th>
              <th>Notes</th>
          </tr>
      </thead>
      <tbody>
          <tr>
              <td><span class="parametername">Type</span></td>
              <td>
                    string
  
                  
              </td>
              <td><p>The type.</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">TimeOfDayTicks</span></td>
              <td>
                    integer
                      (int64)
  
                  
              </td>
              <td><p>The time of day.</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">IntervalTicks</span></td>
              <td>
                    integer
                      (int64)
  
                  
              </td>
              <td><p>The interval.</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">SystemEvent</span></td>
              <td>
  
                      <a href="#MediaBrowser_Model_Tasks_SystemEvent" class="typelink">SystemEvent</a>
                  
              </td>
              <td><p>Enum SystemEvent</p>
</td>
          </tr>
          <tr>
              <td><span class="parametername">DayOfWeek</span></td>
              <td>
  
                      <a href="#System_DayOfWeek" class="typelink">DayOfWeek</a>
                  
              </td>
              <td></td>
          </tr>
          <tr>
              <td><span class="parametername">MaxRuntimeTicks</span></td>
              <td>
                    integer
                      (int64)
  
                  
              </td>
              <td><p>The maximum runtime ticks.</p>
</td>
          </tr>
      </tbody>
  </table>
  
  <h3 id="MediaBrowser_Model_Tasks_SystemEvent" class="text-capitalize">SystemEvent</h3>
  <div>
      <p>see also <a href="../../pluginapi/MediaBrowser.Model.Tasks.SystemEvent.html">MediaBrowser.Model.Tasks.SystemEvent</a></p>

  </div>
  <h5>Enum Values</h5>
  <ul>
  <li>WakeFromSleep</li>
  <li>DisplayConfigurationChange</li>
  <li>NetworkChange</li>
  </ul>
  
  <h3 id="System_DayOfWeek" class="text-capitalize">DayOfWeek</h3>
  <div>
      <p>see also <a href="https://learn.microsoft.com/dotnet/api/system.dayofweek">System.DayOfWeek</a></p>

  </div>
  <h5>Enum Values</h5>
  <ul>
  <li>Sunday</li>
  <li>Monday</li>
  <li>Tuesday</li>
  <li>Wednesday</li>
  <li>Thursday</li>
  <li>Friday</li>
  <li>Saturday</li>
  </ul>
</div>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                </ul>
              </div>
              <div class="sdkversion Release">
                  SDK <span class="sdkVersionSpan"></span>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>On this Page</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to Top</a>
            </span>
            Copyright 2022 © EMBY LLC.  Please see our <a class="lnk" href="https://emby.media/terms.html">terms of use</a> and <a class="lnk" href="https://emby.media/privacy.html">privacy policy</a>.
            
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../../../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../../../searchIndex.js"></script>
    <script type="text/javascript" src="../../../styles/lunr.min.js"></script>
    <script type="text/javascript" src="../../../styles/docfx.js"></script>
    <script type="text/javascript" src="../../../styles/main.js"></script>
  </body>
</html>
